org.springframework.web.portlet.handler

Class SimplePortletHandlerAdapter

java.lang.Object

org.springframework.web.portlet.handler.SimplePortletHandlerAdapter

All Implemented Interfaces:

Aware, PortletContextAware, HandlerAdapter

public class SimplePortletHandlerAdapter
extends java.lang.Object
implements HandlerAdapter, PortletContextAware

Adapter to use the Portlet interface with the generic DispatcherPortlet. Calls the Portlet's render and processAction methods to handle a request.

This adapter is not activated by default; it needs to be defined as a bean in the DispatcherPortlet context. It will automatically apply to mapped handler beans that implement the Portlet interface then.

Note that Portlet instances defined as bean will not receive initialization and destruction callbacks, unless a special post-processor such as SimplePortletPostProcessor is defined in the DispatcherPortlet context.

Alternatively, consider wrapping a Portlet with Spring's PortletWrappingController. This is particularly appropriate for existing Portlet classes, allowing to specify Portlet initialization parameters, etc.

Since:

2.0

Author:

John A. Lewis

See Also:

javax.portlet.Portlet, SimplePortletPostProcessor, PortletWrappingController

Field Summary

Fields

Modifier and Type	Field and Description
private PortletContext	portletContext

Constructor Summary

Constructors

Constructor and Description
SimplePortletHandlerAdapter()

Method Summary

Modifier and Type	Method and Description
void	handleAction(ActionRequest request, ActionResponse response, java.lang.Object handler) Use the given handler to handle this action request.
void	handleEvent(EventRequest request, EventResponse response, java.lang.Object handler) Use the given handler to handle this event request.
ModelAndView	handleRender(RenderRequest request, RenderResponse response, java.lang.Object handler) Use the given handler to handle this render request.
ModelAndView	handleResource(ResourceRequest request, ResourceResponse response, java.lang.Object handler) Use the given handler to handle this resource request.
void	setPortletContext(PortletContext portletContext) Set the PortletContext that this object runs in.
boolean	supports(java.lang.Object handler) Given a handler instance, return whether or not this HandlerAdapter can support it.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

portletContext

private PortletContext portletContext

Constructor Detail

SimplePortletHandlerAdapter

public SimplePortletHandlerAdapter()

Method Detail

setPortletContext

public void setPortletContext(PortletContext portletContext)

Description copied from interface: PortletContextAware

Set the PortletContext that this object runs in.

Invoked after population of normal bean properties but before an init callback like InitializingBean's afterPropertiesSet or a custom init-method. Invoked after ApplicationContextAware's setApplicationContext.

Specified by:

setPortletContext in interface PortletContextAware

Parameters:

portletContext - PortletContext object to be used by this object

supports

public boolean supports(java.lang.Object handler)

Description copied from interface: HandlerAdapter

Given a handler instance, return whether or not this HandlerAdapter can support it. Typical HandlerAdapters will base the decision on the handler type. HandlerAdapters will usually only support one handler type each.

A typical implementation:

return (handler instanceof MyHandler);

Specified by:

supports in interface HandlerAdapter

Parameters:

handler - handler object to check

Returns:

whether or not this object can use the given handler

handleAction

public void handleAction(ActionRequest request,
                         ActionResponse response,
                         java.lang.Object handler)
                  throws java.lang.Exception

Description copied from interface: HandlerAdapter

Use the given handler to handle this action request. The workflow that is required may vary widely.

Specified by:

handleAction in interface HandlerAdapter

Parameters:

request - current action request

response - current action response

handler - handler to use. This object must have previously been passed to the supports method of this interface, which must have returned true.

Throws:

java.lang.Exception - in case of errors

See Also:

javax.portlet.Portlet#processAction

handleRender

public ModelAndView handleRender(RenderRequest request,
                                 RenderResponse response,
                                 java.lang.Object handler)
                          throws java.lang.Exception

Description copied from interface: HandlerAdapter

Use the given handler to handle this render request. The workflow that is required may vary widely.

Specified by:

handleRender in interface HandlerAdapter

Parameters:

request - current render request

response - current render response

handler - handler to use. This object must have previously been passed to the supports method of this interface, which must have returned true.

Returns:

ModelAndView object with the name of the view and the required model data, or null if the request has been handled directly

Throws:

java.lang.Exception - in case of errors

See Also:

javax.portlet.Portlet#render

handleResource

public ModelAndView handleResource(ResourceRequest request,
                                   ResourceResponse response,
                                   java.lang.Object handler)
                            throws java.lang.Exception

Description copied from interface: HandlerAdapter

Use the given handler to handle this resource request. The workflow that is required may vary widely.

Specified by:

handleResource in interface HandlerAdapter

Parameters:

request - current render request

response - current render response

handler - handler to use. This object must have previously been passed to the supports method of this interface, which must have returned true.

Returns:

ModelAndView object with the name of the view and the required model data, or null if the request has been handled directly

Throws:

java.lang.Exception - in case of errors

See Also:

javax.portlet.ResourceServingPortlet#serveResource

handleEvent

public void handleEvent(EventRequest request,
                        EventResponse response,
                        java.lang.Object handler)
                 throws java.lang.Exception

Description copied from interface: HandlerAdapter

Use the given handler to handle this event request. The workflow that is required may vary widely.

Specified by:

handleEvent in interface HandlerAdapter

Parameters:

request - current action request

response - current action response

handler - handler to use. This object must have previously been passed to the supports method of this interface, which must have returned true.

Throws:

java.lang.Exception - in case of errors

See Also:

javax.portlet.EventPortlet#processEvent